/*
 * Copyright (c) 2010 Curtis Boyden.  All rights reserved. 
 * This software was developed by Curtis Boyden and is provided under the terms 
 * of the GNU Lesser General Public License, Version 2.1. You may not use 
 * this file except in compliance with the license. If you need a copy of the license, 
 * please go to http://www.gnu.org/licenses/lgpl-2.1.txt. The Original Code is ejMud
 * (Ewerp Java MUD).  The Initial Developer is Curtis Boyden.
 *
 * Software distributed under the GNU Lesser Public License is distributed on an "AS IS" 
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or  implied. Please refer to 
 * the license for the specific language governing your rights and limitations.
 */

package com.ewerp.mud.core.lifecycle;

import com.ewerp.mud.core.plugin.IPlugin;

/**
 * Implement {@link ILifecycleListener} on any {@link IPlugin} to be notified of
 * system state events.
 * 
 * @author cboyden
 * 
 */
public interface ILifecycleListener {

    /**
     * Called when ejMud is initializing, before any logic threads should
     * execute. ejMud objects should be readied for operation.
     */
    public void init();

    /**
     * Called when the logic threads should begin. ejMud should become
     * operational using this state notification.
     */
    public void start();

    /**
     * Called when listeners should begin their shutdown sequence. Stop all
     * logic threads and save any world and engine state information.
     */
    public void stop();

}
